Generate fips/UserGuide.md from updatecryptodocs with Go structs#2394
Merged
karianna merged 1 commit intoJul 5, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends eng/_util/cmd/updatecryptodocs to also generate eng/doc/fips/UserGuide.md from structured Go data plus embedded narrative Markdown, keeping the User Guide maintained by the same tooling used for CrossPlatformCryptography.md.
Changes:
- Add a User Guide generator (
userguide.go) driven by structured content (userguide_content.go) plus embedded preamble/intro Markdown. - Introduce a shared crypto package registry (
packages.go) and use it to keep generated docs’ package links consistent. - Update
updatecryptodocsCLI + tests to support generatingcrossplatform,userguide, orall, and add a reproducibility test for the User Guide.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| eng/doc/fips/UserGuide.md | Regenerated User Guide output (now marked generated; includes typo/link fixes). |
| eng/_util/cmd/updatecryptodocs/userguide.go | New renderer + TOC generator for the User Guide. |
| eng/_util/cmd/updatecryptodocs/userguide_content.go | New structured “source of truth” for User Guide package/API content + link refs. |
| eng/_util/cmd/updatecryptodocs/userguide_preamble.md | Embedded User Guide preamble text. |
| eng/_util/cmd/updatecryptodocs/userguide_using.md | Embedded “backends” + “using APIs” narrative section. |
| eng/_util/cmd/updatecryptodocs/packages.go | New shared registry/helpers for package ordering and pkg.go.dev links. |
| eng/_util/cmd/updatecryptodocs/updatecryptodocs.go | CLI extended to generate multiple docs; package-link printing now uses shared registry. |
| eng/_util/cmd/updatecryptodocs/updatecryptodocs_test.go | Adds reproducibility test for the generated User Guide. |
Member
Author
|
Marked all AI comments as resolved. There are problems in the document, but this PR is just adding tooling. Problems should be fixed as followup instead. |
Merged
qmuntal
approved these changes
Jul 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update eng/_util/cmd/updatecryptodocs to also maintain the user guide.
I haven't reviewed the generator code in depth, just made sure it has a reasonable-looking amount of structure, and the changes to the doc are reasonable.
Fixes some typos and broken links as a side effect.